Add versionedjob contrib package with basic versioning framework
#39
+678
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brandur
force-pushed
the
brandur-versioned-job
branch
from
83512d6 to
be6ba5e
Compare
brandur
force-pushed
the
brandur-versioned-job
branch
from
be6ba5e to
13d81f2
Compare
Here, add a contrib package called `versionedjob` that brings in a very basic job versioning framework. The framework is very lightweight and users could easily have written it themselves, but it might be a little non-obvious how to leverage hooks to bring it in. Contrib should be a really nice home for this feature because it's a little too trivial to bother with in core, but it's nice for people to have a semi-official reference that's well-maintained.
brandur
force-pushed
the
brandur-versioned-job
branch
from
13d81f2 to
aab9fad
Compare
Contributor
Author
|
Nice. @bgentry Want to take a look at this too? Might make a good blog post at least. |
bgentry
approved these changes
Dec 29, 2025
Contributor
bgentry
left a comment
bgentry
left a comment
There was a problem hiding this comment.
Seems like one good way to do this! Another is to implement a custom UnmarshalJSON on your arg type.
| } | ||
| ``` | ||
|
|
||
| The `VersionTransformer` implementation handles version upgrades one by one. Jobs which are multiple versions old can still be upgraded because multiple version changes can be applied in one go. This implementation uses `gjson`/`sjson` so that each change need only know a minimum about the data object in question and that unknown fields are retained. Other approaches are possible though, including using only Go's built-in `gjson` package. |
Contributor
There was a problem hiding this comment.
I assume you meant encoding/json?
Suggested change
| The `VersionTransformer` implementation handles version upgrades one by one. Jobs which are multiple versions old can still be upgraded because multiple version changes can be applied in one go. This implementation uses `gjson`/`sjson` so that each change need only know a minimum about the data object in question and that unknown fields are retained. Other approaches are possible though, including using only Go's built-in `gjson` package. | |
| The `VersionTransformer` implementation handles version upgrades one by one. Jobs which are multiple versions old can still be upgraded because multiple version changes can be applied in one go. This implementation uses `gjson`/`sjson` so that each change need only know a minimum about the data object in question and that unknown fields are retained. Other approaches are possible though, including using only Go's built-in `encoding/json` package. |
Contributor
Author
I think one reason you might want to do this separately is that eventually all non-trivial version transformations tend to involved fetching data from the DB (this is what happened at Stripe anyway), so you probably want to have a struct you can add a DB pool to and access to This is definitely something to make clear in an eventual blog post though. |
brandur
added a commit
that referenced
this pull request
Jan 18, 2026
Prepare a periodic release for rivercontrib. This largely contains a new lightweight version change framework as seen in #39.
brandur
added a commit
that referenced
this pull request
Jan 18, 2026
Prepare a periodic release for rivercontrib. This largely contains a new lightweight version change framework as seen in #39. [skip ci]
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Here, add a contrib package called
versionedjobthat brings in a verybasic job versioning framework. The framework is very lightweight and
users could easily have written it themselves, but it might be a little
non-obvious how to leverage hooks to bring it in.
Contrib should be a really nice home for this feature because it's a
little too trivial to bother with in core, but it's nice for people to
have a semi-official reference that's well-maintained.